OPC Studio User's Guide and Reference
ObtainNewCertificateAsync(IEasyUAClientServerApplication,UAObtainCertificateArguments,IProgress<String[]>,CancellationToken) Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Application.Extensions Namespace > IEasyUAClientServerApplicationExtension Class > ObtainNewCertificateAsync Method : ObtainNewCertificateAsync(IEasyUAClientServerApplication,UAObtainCertificateArguments,IProgress<String[]>,CancellationToken) Method
The OPC UA client/server application object that will perform the operation.
The arguments describing how the certificate should be obtained.
A provider for progress updates.
A cancellation token for canceling the operation.
Asynchronously obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function ObtainNewCertificateAsync( _
   ByVal application As IEasyUAClientServerApplication, _
   ByVal arguments As UAObtainCertificateArguments, _
   ByVal progress As IProgress(Of String()), _
   ByVal cancellationToken As CancellationToken _
) As Task(Of IPkiCertificate)
'Usage
 
Dim application As IEasyUAClientServerApplication
Dim arguments As UAObtainCertificateArguments
Dim progress As IProgress(Of String())
Dim cancellationToken As CancellationToken
Dim value As Task(Of IPkiCertificate)
 
value = IEasyUAClientServerApplicationExtension.ObtainNewCertificateAsync(application, arguments, progress, cancellationToken)

Parameters

application
The OPC UA client/server application object that will perform the operation.
arguments
The arguments describing how the certificate should be obtained.
progress
A provider for progress updates.
cancellationToken
A cancellation token for canceling the operation.

Return Value

Returns a task that represents the asynchronous operation. The value of the TResult contains the certificate obtained from the certificate manager.
Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

The operation is asynchronous, because it involves multiple steps, and waiting for a finalization of the request by the GDS (see the OpcLabs.EasyOpc.UA.Gds.IEasyUACertificateManagement.FinishRequest method).

For a synchronous alternative, see the ObtainNewCertificate(IEasyUAClientServerApplication,UAEndpointDescriptor) extension method and its overloads.

For an alternative based on asynchronous programming model (APM, System.IAsyncResult) pattern, see the BeginObtainNewCertificate method and related extension methods.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also